﻿//////////////////////////////////////////////////////////////////////////////
//
//  Copyright © 1998-2024 Glodon Company Limited.  All rights reserved.
//
//  Use of this software is subject to the terms of the Glodon license
//  agreement provided at the time of installation or download, or which
//  otherwise accompanies this software in either electronic or hard copy form.  
//
//////////////////////////////////////////////////////////////////////////////

// Reviewed
#pragma once

#include "GcmpModelInterface.h"
#include "IDbObject.h"
#include "JoinPositions.h"
#include "RegenDataId.h"

namespace gcmp
{
    class IElementJoin;
    class IDocument;
    class IElement;
    class IGraphicsElementShape;
    

    /// \brief 对象连接行为
    /// 
    /// 用于扩展ElementJoin的行为
    class GCMP_MODEL_INTERFACE_EXPORT IElementJoinBehavior : public IDbObject
    {
        DEFINE_CAST_DERIVED(gcmp::IElementJoinBehavior, gcmp::IDbObject)
    public:
        /// \brief 创建一个空的IElementJoinBehavior
        /// \return 对象连接行为指针
        static OwnerPtr<IElementJoinBehavior> CreateElementJoinNullBehavior(IDocument* pDoc);

        /// \brief 克隆
        /// \return 对象连接行为指针
        virtual OwnerPtr<IElementJoinBehavior> Clone() const = 0;

        /// \brief 获取宿主对象的id
        /// \return 宿主对象的id
        virtual ElementId GetOwnerElementId() const = 0;

        /// \brief 设置宿主对象的id
        /// \param id 宿主对象的id
        /// \return void
        virtual void SetOwnerElementId(const ElementId& id) = 0;

        /// \brief 获取当前文档
        /// \return 当前文档
        virtual IDocument* GetDocument() const = 0;

        /// \brief 设置当前文档
        /// \param pDocument 当前文档
        /// \return void
        virtual void SetDocument(const IDocument* pDocument) = 0;

        /// \brief 报告连接计算器所需的所有数据
        ///
        /// 会影响连接计算器的数据需要在此函数中报告出来
        /// \param regenDataIds 计算输出数据所要用到数据的RegenDataId，regenDataIds既是输入数据，又是输出数据，不允许在函数内清空数据。
        /// \return void
        virtual void ReportInputDataIds(std::vector<RegenDataId> & regenDataIds) const = 0;

        /// \brief 计算Element连接之后的图形表示
        ///
        /// \param pTargetElement 连接的目标对象
        /// \param pBaseGraphicsElementShape Element连接之前的图形表示
        /// \param opJoinedGraphicsElementShape Element连接之后的图形表示
        /// \return 返回true表示计算成功，opJoinedGraphicsElementShape值有效，否则表示失败。
        virtual bool CalculateJoinedGraphicsElementShape(IElement* pTargetElement, const IGraphicsElementShape* pBaseGraphicsElementShape, OwnerPtr<IGraphicsElementShape>& opJoinedGraphicsElementShape) = 0;
   
        /// \brief 判断CutterGrep是否需要连接
        ///
        /// \return 返回true表示需要连接，否则表示false
        virtual bool IsCutterGraphicsElementShapeJoinable() const = 0;
    };
}


